package com.zy.explore.web.constraints;


import com.zy.explore.web.constraints.validator.InEnumValidator;

import javax.validation.Constraint;
import javax.validation.Payload;
import java.lang.annotation.Documented;
import java.lang.annotation.Retention;
import java.lang.annotation.Target;

import static java.lang.annotation.ElementType.*;
import static java.lang.annotation.RetentionPolicy.RUNTIME;

/**
 * @author Administrator
 */
@Documented
@Constraint(validatedBy = {InEnumValidator.class})
@Target({FIELD, CONSTRUCTOR, PARAMETER})
@Retention(RUNTIME)
public @interface InEnum {

    /**
     * 限定枚举
     *
     * @return 枚举类
     */
    Class<? extends Enum<?>> value();

    /**
     * 是否必须
     * 是 当该值为 null 时，会进行校验
     * 否 当该值为 null 时，不进行校验
     *
     * @return boolean
     */
    boolean required() default true;

    /**
     * 允许的枚举类 名称 数组
     *
     * @return String
     */
    String[] permits() default {};

    String message() default "属性值需要是 [{value}] 枚举，并且限制值为 {permits}";

    Class<?>[] groups() default {};

    Class<? extends Payload>[] payload() default {};
}
